home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / zboot16.arc / ZBOOT.DOC < prev    next >
Text File  |  1990-03-14  |  20KB  |  488 lines
  1.                 _______________________________________________ 
  2.  
  3.                                      ZBOOT
  4.  
  5.                        Zmodem General Purpose Interface
  6.  
  7.                                   Version 1.6
  8.  
  9.                       from Hank Volpe (c) 1988, 1989, 1990
  10.  
  11.                                released 3-10-90
  12.  
  13.                 ______________________________________________
  14.  
  15.  
  16.     Introduction
  17.     ------------
  18.     Zboot.exe is a program that allows you to interface your communications
  19.     program to the Zmodem (DSZ's)transfer protocol.  Zboot can be 
  20.     run in a dos shell from any communications program,  or in an 
  21.     integrated method with any communications program.
  22.  
  23.     Zboot  requires at least 20K of memory above your communication program 
  24.     and  at least 64K for DSZ.COM to execute.  In a standard 640K  machine, 
  25.     there is plenty of room for several TSR's, a COMM program, and Zboot to 
  26.     operate.
  27.  
  28.     What's New in Version 1.6
  29.     -------------------------
  30.     ** New Command switches (S & P) make Zboot compatible with every 
  31.        Communications Program.
  32.  
  33.     ** New Error Code Format. Zboot Now returns messages telling you
  34.        why it or DSZ failed to run. The screen pauses after errors too
  35.        so that you have time to read what the error condition was.
  36.  
  37.     Other Standard Zboot Features
  38.     -----------------------------
  39.  
  40.     ** Zboot uses DSZ's Crash Recovery and File Comparison.  If you 
  41.        get  cut off in the middle of a transfer,  you can start a 
  42.        recovery  of the file from where you left off!
  43.  
  44.     ** Zboot works with Qmodem and Procomm. 
  45.        In fact, it will work with any COMM program  whether it passes
  46.        filenames to Zboot or not!
  47.  
  48.     ** Support For High Speed Modems to 38.4K with all the
  49.        proper handshaking to prevent Serial Port overruns.
  50.  
  51.     ** Use of a 4K Communications Buffer to help High Speed Connections
  52.        achieve maximum character throughput.
  53.  
  54.     ** Auto-prompting of filenames during uploads (if filename was not
  55.        passed to Zboot by your COMM program.
  56.  
  57.  
  58.  
  59.                                        1
  60.  
  61.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  62.  
  63.     ** Zboot will switch to separate download or upload directories
  64.        if you specify a full path name as part of the filename to send.
  65.        Zboot then returns to the directory it was called from after the
  66.        upload or download is completed.
  67.  
  68.     ** DSZ called from a path. You do not have to keep DSZ.COM in any 
  69.        special directory, just make sure you have set a path to it using
  70.        Dos's  Set PATH  command.
  71.  
  72.     ** Interactive Mode which allows the installation of DSZ as an
  73.        external protocol in COMM programs that don't allow external
  74.        protocols. The Interactive Mode can be installed as an external
  75.        editor or shelled to from DOS.
  76.  
  77.  
  78.  
  79.     WHAT DOES ZBOOT DO THAT A BATCH FILE CANT??
  80.     ------------------------------------------
  81.     Most external protocol interfaces are handled through batch files, and
  82.     if you are familiar with standard Batch commands, they are limited.
  83.     Although Zboot takes up to 20K to run, it handles many different
  84.     situations that you normally can't handle in batch files without
  85.     a lot of code. Zboot sets the proper port, speed, switches to the
  86.     correct download or upload directories, sets the correct handshaking
  87.     method and then switches back to the default directory after it
  88.     is finished. No batch hassles or errors!
  89.  
  90.     Also as versions of Zboot evolved, improvements were made to take
  91.     advantage of some of the newer features of DSZ.COM. When used with
  92.     a COMM program, Zboot will automatically select the correct handshaking 
  93.     mode for DSZ. Handshaking is normally not important unless the terminal 
  94.     to  modem  speed is 9600 bps or higher.  Zboot now  will  automatically 
  95.     switch to CTS checking using the "handshaking both" mode when 9600  bps 
  96.     is  selected  and  will  switch to "handshake  slow"  for  higher  rate 
  97.     transfers. (Handshake slow is implemented in the April release of DSZ). 
  98.     On  most systems,  speeds of 19200 bps without handshake slow create  a 
  99.     lot of errors.
  100.  
  101.     Finally, for users of other Communication programs, there is an
  102.     interactive mode that calls DSZ. It allows you to work with DSZ
  103.     in a shell vs using DSZ's complicated command-line structure.
  104.  
  105.  
  106.     INSTALLATION
  107.     ------------
  108.     The file Zboot.exe can be contained anywhere on your disk, however if
  109.     it is not in the same directory that your communications program is in,
  110.     then you should have a path to it in your system environment.  DSZ.COM
  111.     (or .exe depending on the version), which contains the Zmodem protocol
  112.     from Omen Technology can also be in any directory as long as it is also
  113.     in one of the paths in your system environment. Make sure you are using
  114.     a version of DSZ.COM later than 4-17-89 in order to use the 19200 and
  115.     9600 bps handshaking selections. If you wish to use the Qmodem
  116.     interface (or believe your communications program will work in this
  117.     manner) then read the section devoted to Qmodem and its interface.
  118.  
  119.  
  120.                                        2
  121.  
  122.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  123.  
  124.  
  125.     If you wish to use Zboot with Procomm or any other COMM program, just
  126.     follow  the same procedure that is outline in the next section and 
  127.     then read the special section entitled, "USING OTHER COMM PROGRAMS"
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.     INTEGRATED ENVIRONMENT INSTALLATION
  135.     -----------------------------------
  136.     Zboot can be installed as an external protocol using Qmodem version 3.0
  137.     or  higher.  It  can also be installed in Procomm Plus (both  the  test 
  138.     drive and the registered version).
  139.  
  140.     Qmodem Installation -
  141.     ---------------------
  142.  
  143.       Quick Qmodem Summary - For Seasoned Users
  144.       -----------------------------------------
  145.  
  146.     1) Select the Install mode (ALT-N or with Qinstall)
  147.     2) Enter the name of the protocol, and Zboot T for transmit
  148.        and Zboot R for receive batch file names.
  149.     3) Tell Qmodem you want to send filename prompts.
  150.  
  151.  
  152.     1-2-3 That's it!...Zboot /DSZ / and Qmodem are ready to work together.
  153.  
  154.  
  155.  
  156.     Qmodem Installation - for Information and Background Seekers
  157.     -----------------------------------------------------------
  158.     To  do  this,  you  must run the Qmodem install program and  enter  the 
  159.     following information as listed from Qinstall (or while in Qmodem 4.0's 
  160.     ALT-N install mode);
  161.  
  162.     Qmodem 3.x installation with Qinstall
  163.     -------------------------------------
  164.     Sel    Name of           Upload Batch      Download Batch    Download File
  165.     Char   Protocol          Filename          Filename          Prompt [Y/N]
  166.  
  167.     [Z]    [Zmodem      ]    [ZBOOT.EXE T ]    [ZBOOT.EXE R ]       [Y]
  168.                             or ZBOOT S        or ZBOOT P
  169.                        for prompted upload    for prompted download
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.                                        3
  182.  
  183.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  184.  
  185.  
  186.  
  187.     Qmodem 4.x installation using Alt-N
  188.     -----------------------------------
  189.     After  the  sliding bar appears,  move the cursor to  Protocols,  press 
  190.     return.  Move  the  sliding  bar to the number you wish  Zmodem  to  be 
  191.     installed as. Press return and answer these questions;
  192.  
  193.      Select character   Z             
  194.      Protocol           ZMODEM
  195.      Upload BAT         ZBOOT T  (or ZBOOT S for prompted upload)
  196.      Download BAT       ZBOOT R  (or ZBOOT P for prompted download)
  197.      Filename Prompt    Y
  198.   
  199.     NOTE:  The Prompted mode should not be necessary for Qmodem at all.  It 
  200.     is mentioned here only so you know the option exists. If you don't have 
  201.     Qmodem, then S and P maybe options you might be interested in. Read the 
  202.     special  section explaining these Command line switches at the  end  of 
  203.     the next section.
  204.  
  205.     Qmodem was designed to work with user written batch files, which if you
  206.     enter a Y for prompt, will send all the necessary information to the
  207.     file for downloading. Zboot takes advantage of this feature. The T
  208.     after Zboot.exe (upload) and the R after Zboot.exe (download) are used
  209.     by Zboot to determine if you want to upload or download a file. Qmodem
  210.     then returns the next group of parameters to Zboot and the process is
  211.     "hands off". In summary;
  212.  
  213.  
  214.  
  215.         parameter 1 = R or T (from the Command interface above)
  216.         parameter 2 = Baud Rate (used to determine handshaking mode)
  217.         parameter 3 = Comm port in use
  218.         parameter 4 = Filename to down or upload (wildcards accepted)
  219.  
  220.                  (then DSZ begins to execute)
  221.  
  222.     Note again that only if you enter the R or T after Zboot.exe above will
  223.     Zboot be able to work from Qmodem directly. Also, you must turn on the
  224.     prompted file output to send the filename to Zboot without retyping it.
  225.     If you do not include the R or T, Zboot will default to the Interactive 
  226.     mode, which is fine, except now you will have to tell Zboot whether you 
  227.     wish  to  transmit or receive,  and you need to enter the name  of  the 
  228.     file.
  229.  
  230.     If  you  wish  to use Zboot interactively at times,  I  would  suggest 
  231.     installing it as the editor or shell to it using the ALT-R command.
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.                                        4
  243.  
  244.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  245.  
  246.  
  247.  
  248.     Using other COMM programs
  249.     -------------------------
  250.  
  251.     Version  1.6 of Zboot now works with any COMM program.  Procomm  allows 
  252.     the use of external protocols,  but it does not pass any communications 
  253.     parameters  (like Qmodem does) to the external protocol except for  the 
  254.     upload  file name.  This causes the most trouble for novice users  that 
  255.     are trying to write batch files that will work with Procomm and DSZ.
  256.  
  257.     Installing Zboot with Procomm
  258.     ------------------------------
  259.     1) To install Zboot in Procomm,  select the File Protocols section from 
  260.     the setup menu (ALT-S). 
  261.  
  262.     2) Enter as the name of the upload external protocol name ZBOOT T
  263.     Next, enter the name of the download external protocol ZBOOT R
  264.  
  265.     Note that you can select any of the external option positions for
  266.     Zboot, but the test drive version of Procomm only allows externals
  267.     1 through 3. 
  268.  
  269.     Also note, Procomm users : Unless you type the full pathname (directory 
  270.     and filename),  Procomm won't pass that information to Zboot. You might 
  271.     want  instead to use the switches S (For Uploads) or P (For downloads) 
  272.     instead  of T and R.  These switches are explained below and  might  be 
  273.     better  for you if you wish to use download and upload directories  but 
  274.     don't feel like typing the whole path\filename.
  275.  
  276.  
  277.     1-2 That's it!...Zboot/ DSZ/ and Procomm are ready to work together.
  278.  
  279.  
  280.     Installing Zboot with Telix or other Comm Programs
  281.     --------------------------------------------------
  282.  
  283.     Since  there really is no "correct" way or standard way to pass command 
  284.     arguments from a program to an external protocol,  each  Communications 
  285.     program takes a different approach.  If you are using any other program 
  286.     besides Qmodem and Procomm,  you can now use Zboot and have it function 
  287.     correctly,  even  if  your  program  cannot  pass  parameters  or  send 
  288.     filenames by using the new command prompt switches S and P.
  289.  
  290.     When  you  install  Zboot as an external protocol and use ZBOOT  S  for 
  291.     uploading  and ZBOOT P for downloading,  you are instructing  Zboot  to 
  292.     work in a generic mode. S instructs Zboot to upload, but to ask you for 
  293.     a path name (directory\filename) that you wish to transmit. P instructs 
  294.     Zboot  to ask for a directory\filename you wish to download.  P doesn't 
  295.     actually need the filename, just a directory ending with a \..ie...
  296.     download\ (if you were sending a file to a directory that is a child of 
  297.     your current one called download. The \ is needed so that the directory 
  298.     can be properly separated from the filename,  even with the P option. A 
  299.     filename is always required on an upload.
  300.  
  301.  
  302.  
  303.                                        5
  304.  
  305.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  306.  
  307.     This  Generic  mode is different from the interactive mode  because  by 
  308.     using the S or P switches,  Zboot already knows what you want to do and 
  309.     only needs the filename.  How did it get the Comm port?  How did it get 
  310.     the baud rate ? That again is another reason why Zboot is more flexible 
  311.     than any batch file.
  312.  
  313.     In this Generic mode, Zboot first scans all available COMM ports (up to 
  314.     4  Maximum  following  DSZ's and  PC-standard  serial  port  addresses) 
  315.     looking for a Carrier Detect (CD or RLS) signal to be active.  The COMM 
  316.     port  currently  on line will be the only one with this carrier  signal 
  317.     (for  if it doesn't have a carrier,  or if multiple lines are  up,  DSZ 
  318.     also will not operate).
  319.  
  320.     Next,  Zboot  reads the Divisor latch registers of the UART directly to 
  321.     determine  the correct baud rate to use.  Based on  this,  the  correct 
  322.     handshaking for DSZ is also selected (Correct Handshaking is  essential 
  323.     for speeds over 9600 bps).
  324.  
  325.     Finally Zboot invokes DSZ passing all the appropriate parameters to it.
  326.  
  327.     Using Zboot with S and P switches makes it possible to interface to
  328.     any  program.  If you are using a very old Communications  program,  it 
  329.     might not be able to do anything but call Zboot ,  in other words,  the 
  330.     S,T,P,R  commands also cannot get passed through.  What do you do  now? 
  331.     Simple, just read below.
  332.  
  333.  
  334.     USING ZBOOT FROM A DOS SHELL OR AS AN EXTERNAL EDITOR
  335.     -----------------------------------------------------
  336.  
  337.     As stated earlier, Zboot will run from a Dos prompt and allow you to
  338.     use DSZ in a shell (instead of from Qmodem directly). You can run
  339.     Zboot in a dos shell inside your communications program too. Why do you
  340.     need the shell? Well primarily it exists to allow interfacing to other
  341.     communications programs that don't allow external protocols to
  342.     be added. Such an example is the 2.12 version of Telix. By substituting
  343.     Zboot as either the external editor, or by exiting to a dos shell, you
  344.     can  now use DSZ easily from these programs.  Zboot run in this  manner 
  345.     would  be needed if your Communications program won't allow the passing 
  346.     of  any command line arguments.  This again would only be a problem  in 
  347.     very old Communications programs,  but people do sometimes like to hold 
  348.     on to trusted friends. So if you need to, the Interactive mode is there 
  349.     for you to use.
  350.  
  351.     Once you have entered the shell,  type Zboot (or if it was installed as 
  352.     an  external  editor,  it will start  automatically).The  program  will 
  353.     interactively  prompt you for the necessary information to start Zmodem 
  354.     transfers.  The  default  COMM port selected is COM1.  Modem  speed  is 
  355.     picked up  by DSZ.COM automatically when executed.  A new Selection  S, 
  356.     for Set the CTS mode has been added.  This allows you to determine  the 
  357.     handshaking   you require between the modem and the computer.  This  is 
  358.     only necessary if you are running a computer to modem speed of 19200 or 
  359.     greater...so  in  most cases you don't need to change a thing (or worry 
  360.     about it) because Zboot will automatically set the correct  handshaking 
  361.     by looking at the current baud rate.  This  command was only put in for 
  362.     the "techies" out there who might want such an  option.
  363.  
  364.                                        6
  365.  
  366.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  367.  
  368.     ERROR MESSAGES
  369.     --------------
  370.  
  371.     New  in Version 1.6 is the ability for Zboot to tell you what was going 
  372.     wrong..in other words,  why DSZ or why Zboot didn't work.  This ability 
  373.     was always there to start. With earlier versions, Zboot returned a 1 if 
  374.     DSZ had a problem or a -1 if Zboot had a problem.  Now,  you will  find 
  375.     out why.
  376.  
  377.     Zboot Errors
  378.     ------------
  379.     If Zboot has a problem, it will return a message saying
  380.  
  381.                  Zboot Error = -1
  382.     and then one of the following messages is displayed;
  383.  
  384.     Argument list too Long  
  385.      - Incorrect arguments passed to DSZ from Zboot
  386.        (Make sure you have a version of DSZ dated 4-22-89 or later)
  387.  
  388.     Invalid  Argument       
  389.      - Incorrect information passed to DSZ from Zboot
  390.        (Make sure you have a version of DSZ dated 4-22-89 or later)
  391.     
  392.     Cant find DSZ.EXE or DSZ.COM in DOS Path or Current 
  393.       - DSZ (either .exe or .com) must be in either the current directory
  394.         that Zboot switched to or in a DOS path. This is the most common
  395.         reason for a failure. Make sure DSZ is in a path. 
  396.  
  397.  
  398.     Exec format error
  399.       - Something is wrong with DSZ, the file may be bad.
  400.  
  401.     Not enough free memory for DSZ to run
  402.       - Zboot needs 20K for itself to run, DSZ another 64K minimum for
  403.         DSZ.COM, more for DSZ.EXE. Run Chkdsk from a DOS shell and see
  404.         how much memory you really have.
  405.  
  406.     Unknown Error -
  407.       - Something happened wrong, but what it is Zboot can't tell
  408.  
  409.  
  410.     DSZ Errors
  411.     -----------
  412.     DSZ couldn't find your file or send/receive it
  413.       - DSZ returns a 1 status, meaning that any number of things went
  414.         wrong including; No carrier, file not found, aborts.. This message
  415.         primarily is to say that Zboot started DSZ ok, but DSZ has a
  416.         problem you need to investigate.
  417.  
  418.     Unknown Error -
  419.       - Something happened wrong, but what it is DSZ can't tell
  420.  
  421.  
  422.  
  423.  
  424.  
  425.                                        7
  426.  
  427.           Zboot Version 1.6 Documentation Copyright (c) Hank Volpe 1989
  428.  
  429.  
  430.     PROGRAM INFORMATION
  431.     -------------------
  432.     Zboot.exe is written in Turbo C using stdin and stdout conventions that
  433.     should make it compatible with all MS-DOS systems. This program is NOT
  434.     released to the public domain, and the author retains all rights to the
  435.     program. However, there is no charge for its use, and it can be freely
  436.     copied and distributed as you wish. The only costs involved are if you
  437.     wish a copy of the source code for custom interfacing. If so, please
  438.     send  $10 to cover postage, disks and other related costs to;
  439.  
  440.  
  441.                                   Hank  Volpe 
  442.                                108 Broadmoor Drive
  443.                                Tonawanda NY, 14150
  444.  
  445.     This  program  is "free" for several reasons.  First,  DSZ is  a  great 
  446.     package,  and this extends its reach to people who cannot either set it 
  447.     up   properly   or  understand  the  more  technical  side   of   modem 
  448.     communications.  Secondly,  as a registered user of DSZ, I do not think 
  449.     it is right to ride on the "coattails" of anyone else. This program is a 
  450.     communications utility in the purest form.  The source code is for sale 
  451.     only because of the time spent in updating Zboot and nothing else.
  452.  
  453.     I would however like to hear from you,  in writing,  if you enjoy Zboot 
  454.     and  hear what features,  implementations or other utilities you  would 
  455.     like to see added to it. Just drop me a line at the address above.
  456.  
  457.  
  458.     Notes:
  459.     Turbo C copyright by Borland International 
  460.     DSZ.COM  and references to Crash and File Recovery and DSZ are
  461.              Copyright by Omen Technology inc. 
  462.            
  463.     Qmodem copyright by John Freil and the Forbin Project
  464.     Procomm copyright by Datastorm 
  465.     Telix copyright by Ptel
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.                                        8
  487.  
  488.